package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.NewsFileAddDTO;
import org.jsola.hr.dto.NewsFileUpdateDTO;
import org.jsola.hr.query.NewsFileQuery;
import org.jsola.hr.vo.NewsFileListVO;
import org.jsola.hr.vo.NewsFileVO;

import java.util.List;

/**
 * 官网新闻内容附带的附件
 *
 * @author zhr
 */
@Api(tags = "hr-官网新闻内容附带的附件")
public interface INewsFileControllerAPI {

    /**
     * 新增官网新闻内容附带的附件
     * @param newsFileAddDTO 官网新闻内容附带的附件新增实体
     * @return 官网新闻内容附带的附件展示对象
     */
    @ApiOperation(value = "新增官网新闻内容附带的附件")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsFileAddDTO", dataType = "NewsFileAddDTO", value = "新增官网新闻内容附带的附件", paramType = "body")
    })
    Result<NewsFileVO> save(NewsFileAddDTO newsFileAddDTO);


    /**
     * 修改官网新闻内容附带的附件
     * @param newsFileUpdateDTO 官网新闻内容附带的附件
     * @return 更新数量
     */
    @ApiOperation(value = "修改官网新闻内容附带的附件")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsFileUpdateDTO", dataType = "NewsFileUpdateDTO", value = "修改官网新闻内容附带的附件", paramType = "body")
    })
    Result<Integer> update(NewsFileUpdateDTO newsFileUpdateDTO);




    /**
     * 删除单个官网新闻内容附带的附件，彻底删除
     * @param newsFileId 官网新闻内容附带的附件id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个官网新闻内容附带的附件，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsFileId", dataType = "String", value = "官网新闻内容附带的附件id", paramType = "path")
    })
    Result<Integer> delete(String newsFileId);


    /**
     * 批量删除官网新闻内容附带的附件，彻底删除
     * @param newsFileIds 官网新闻内容附带的附件id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除官网新闻内容附带的附件，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsFileIds", dataType = "String[]", value = "官网新闻内容附带的附件id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] newsFileIds);


    /**
     * 根据官网新闻内容附带的附件id查询官网新闻内容附带的附件详情
     * @param newsFileId 官网新闻内容附带的附件id
     * @return 官网新闻内容附带的附件详情
     */
    @ApiOperation(value="根据官网新闻内容附带的附件id查询官网新闻内容附带的附件详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsFileId", dataType = "String", value = "官网新闻内容附带的附件id", paramType = "path")
    })
    Result<NewsFileVO> findById(String newsFileId);


    /**
     * 查询官网新闻内容附带的附件
     * @param newsFileQuery 官网新闻内容附带的附件查询参数
     * @return page
     */
    @ApiOperation(value="查询官网新闻内容附带的附件")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsFileQuery", dataType = "NewsFileQuery", value = "官网新闻内容附带的附件查询参数", paramType = "query")
    })
    Result<List<NewsFileListVO>> listAll(NewsFileQuery newsFileQuery);


     /**
     * 分页查询官网新闻内容附带的附件
     * @param newsFileQuery 官网新闻内容附带的附件查询参数
     * @return page
     */
    @ApiOperation(value="分页查询官网新闻内容附带的附件")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsFileQuery", dataType = "NewsFileQuery", value = "官网新闻内容附带的附件查询参数", paramType = "query")
    })
    Result<Page<NewsFileListVO>> page(NewsFileQuery newsFileQuery);


}

